docs: refresh stale claims (freshness audit 2026-05-28)#16
Merged
Conversation
…s audit 2026-05-28) Archive (git mv → archive/2026-05-28/): - 04-api/SERVICES_OVERVIEW.md: Nov-2025, called Java API "Kotlin", used H2 in-memory DB - 05-testing/test-report.md: Jan-2025 synthetic static analysis, cited superseded HS256 JWT - modules/biometric-processor.md: "NOT STARTED" status — service is live - modules/identity-core-api.md: "Basic CRUD only" — superseded by MODULE_STRUCTURE.md - modules/client-apps.md, modules/web-app.md, modules/documentation.md: pre-implementation plans superseded by MODULE_STRUCTURE.md In-place edits: - 02-architecture/MODULE_STRUCTURE.md: Flyway "(6 versions)" → "(60 versions)"; archive path 99-archive/ → archive/ - 02-architecture/BIOMETRIC_ENGINE_ARCHITECTURE.md: status "Pre-Implementation" → "Implemented (Phase 4 complete 2026-05-16)"; MobileFaceNet note + geometry-512 client path - 02-architecture/diagrams/README.md: remove dead links PLANTUML_DIAGRAMS_PART2.md, PLANTUML_DIAGRAMS_FIXED.md, SYSTEM_DESIGN_ANALYSIS_AND_DECISION.md, DESIGN_AUDIT_REPORT.md - 06-deployment/README.md: "not yet configured" → prod live on Hetzner CX43 + Docker Compose + Traefik; ./gradlew bootRun → ./mvnw spring-boot:run - 06-deployment/deployment-guide.md: 5 repos → 7 submodules/1 parent (8 total); biometric-processor port 8000 → 8001; ./gradlew → ./mvnw for identity-core-api sections - 06-deployment/START_ALL_SERVICES.md: ./gradlew.bat clean bootJar → ./mvnw clean package for identity-core-api - 07-status/README.md: replaced stale progress bars + broken links with pointer to parent ROADMAP.md - 04-api/README.md, 04-api/BACKEND_FRONTEND_INTEGRATION.md, 04-api/backend-api/SPRINGDOC_SETUP.md: ./gradlew → ./mvnw for identity-core-api - 01-getting-started/API_INTEGRATION_QUICKSTART.md, METRICS_COLLECTION_GUIDE.md: ./gradlew → ./mvnw for identity-core-api - 01-getting-started/GETTING_STARTED.md: hardcoded C:\Users\ahabg\... → path/to/FIVUCSAS - 05-testing/README.md, HOW_TO_TEST_APPS.md, MOBILE_TESTING_GUIDE.md: ./gradlew bootRun → ./mvnw spring-boot:run for identity-core-api; hardcoded paths fixed - README.md: fixed links to archived SERVICES_OVERVIEW.md and test-report.md - archive/README.md: document 2026-05-28 batch Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
There was a problem hiding this comment.
Pull request overview
This PR performs a documentation “freshness audit” by archiving outdated pre-implementation/planning docs and updating remaining docs to reflect the current build/deployment reality (notably Maven usage and production status), while removing links to now-archived materials.
Changes:
- Archived several stale planning/test snapshot documents under
archive/2026-05-28/and updated top-level navigation to point to the archived copies. - Updated multiple guides to reflect Maven (
./mvnw) usage and current service ports (notably biometric-processor on8001). - Simplified status docs to point to the parent repo roadmap and removed dead diagram/status links.
Reviewed changes
Copilot reviewed 18 out of 25 changed files in this pull request and generated 8 comments.
Show a summary per file
| File | Description |
|---|---|
| README.md | Updates navigation links to point at archived service overview and archived test report. |
| archive/README.md | Documents the 2026-05-28 freshness-audit archive move set. |
| archive/2026-05-28/web-app.md | Adds archived snapshot of the web-app implementation plan. |
| archive/2026-05-28/test-report.md | Adds archived synthetic/static “test report” snapshot. |
| archive/2026-05-28/SERVICES_OVERVIEW.md | Adds archived services overview snapshot (now referenced from README). |
| archive/2026-05-28/identity-core-api.md | Adds archived identity-core-api module plan snapshot. |
| archive/2026-05-28/documentation.md | Adds archived docs module plan snapshot. |
| archive/2026-05-28/client-apps.md | Adds archived client-apps module plan snapshot. |
| archive/2026-05-28/biometric-processor.md | Adds archived biometric-processor module plan snapshot. |
| 07-status/README.md | Replaces in-repo status content with a pointer to the parent repo roadmap and lists historical docs. |
| 06-deployment/START_ALL_SERVICES.md | Updates troubleshooting build command from Gradle to Maven. |
| 06-deployment/README.md | Updates backend start command to Maven and refreshes production deployment statement. |
| 06-deployment/deployment-guide.md | Refreshes module-repo structure wording and updates biometric-processor port references to 8001. |
| 05-testing/README.md | Updates backend test commands from Gradle to Maven. |
| 05-testing/MOBILE_TESTING_GUIDE.md | Replaces hardcoded local paths and updates Spring Boot start command to Maven. |
| 05-testing/HOW_TO_TEST_APPS.md | Updates backend start command from Gradle to Maven. |
| 04-api/README.md | Updates backend start command to Maven and repoints services overview link to archive. |
| 04-api/backend-api/SPRINGDOC_SETUP.md | Notes Maven usage and updates build/run/dependency commands from Gradle to Maven. |
| 04-api/BACKEND_FRONTEND_INTEGRATION.md | Updates backend run command to Maven (but retains Gradle-style args syntax). |
| 02-architecture/MODULE_STRUCTURE.md | Refreshes Flyway migration count claim and renames archive folder reference. |
| 02-architecture/diagrams/README.md | Removes links to now-archived PlantUML/design docs and consolidates diagram source reference. |
| 02-architecture/BIOMETRIC_ENGINE_ARCHITECTURE.md | Updates biometric-engine status and notes removal of MobileFaceNet in favor of geometry-512 path. |
| 01-getting-started/METRICS_COLLECTION_GUIDE.md | Updates JaCoCo generation commands from Gradle to Maven. |
| 01-getting-started/GETTING_STARTED.md | Replaces hardcoded Windows local paths with a generic path/to/FIVUCSAS. |
| 01-getting-started/API_INTEGRATION_QUICKSTART.md | Updates backend run command to Maven (but retains Gradle-style args syntax). |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| For the authoritative, up-to-date project status and roadmap, see the parent repository: | ||
|
|
||
| ## Current Status | ||
| **[FIVUCSAS/ROADMAP.md](https://github.com/Rollingcat-Software/FIVUCSAS/blob/master/ROADMAP.md)** — current phase, backlog, and milestone tracking. |
| ```powershell | ||
| cd identity-core-api | ||
| .\gradlew.bat clean bootJar | ||
| ./mvnw clean package -DskipTests |
| cd C:\Users\ahabg\OneDrive\Belgeler\GitHub\FIVUCSAS\identity-core-api | ||
| .\gradlew.bat bootRun | ||
| cd path/to/FIVUCSAS/identity-core-api | ||
| ./mvnw spring-boot:run |
| cd identity-core-api | ||
| export JWT_SECRET=your-dev-secret-key-change-in-production | ||
| ./gradlew bootRun --args='--spring.profiles.active=dev' | ||
| ./mvnw spring-boot:run --args='--spring.profiles.active=dev' |
|
|
||
| ## 2026-05-28 | ||
|
|
||
| Freshness audit. Moved 7 files that were pre-implementation planning docs contradicted by current repo state: |
| # Start Spring Boot | ||
| cd identity-core-api | ||
| .\gradlew.bat bootRun | ||
| ./mvnw spring-boot:run |
|
|
||
| # Run with development profile | ||
| ./gradlew bootRun --args='--spring.profiles.active=dev' | ||
| ./mvnw spring-boot:run --args='--spring.profiles.active=dev' |
Comment on lines
+11
to
+14
| - `archive/2026-04-16/FINAL_COMPLETION_REPORT.md` | ||
| - `archive/2026-04-16/KMP_IMPLEMENTATION_STATUS.md` | ||
| - `archive/2026-04-16/MOBILE_APP_STATUS.md` | ||
| - `archive/2026-04-16/IMPLEMENTATION_STATUS_REPORT.md` |
…udit 2026-05-28) Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
./gradlew→./mvnw, biometric engine status "Pre-Implementation"→"Implemented (Phase 4 complete 2026-05-16)", MobileFaceNet removed note + geometry-512 client pathC:\Users\ahabg\...paths → genericpath/to/FIVUCSASNEEDS YOUR DECISION
01-getting-started/INTEGRATION_GUIDE.md— describesverify.fivucsas.comwidget SDK (@fivucsas/auth-*) as live/installable. Unclear if this SDK is actually published. NOT changed — needs your call on whether to mark it as live, planned, or remove.ADD_diagrams/*.png(5 PNG files in rootADD_diagrams/folder) — not referenced by any markdown file. Flag: archive them or leave? They are not linked anywhere.diagrams/*.drawio(11 drawio files in rootdiagrams/folder) — also not referenced by any markdown file. Same question.CODE CHANGE NEEDED
None.
Test plan
archive/2026-05-28/files are visible in git history./mvnw spring-boot:runin 06-deployment/README.md, 04-api/README.md, 05-testing/README.md🤖 Generated with Claude Code